test: add tests for IEEE 754-2019 compliance #6571

anandkaranubc · 2025-04-05T18:59:32Z

Progresses #365

Description

What is the purpose of this pull request?

This pull request:

Adds all the tests for testing special cases of log*

Related Issues

Does this pull request have any related issues?

This pull request:

progresses Add tests for IEEE 754-2019 compliance #365

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

Read, understood, and followed the contributing guidelines.

@stdlib-js/reviewers

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

anandkaranubc · 2025-04-05T19:01:47Z

All checked!

Planeshifter · 2025-04-05T19:27:22Z

@anandkaranubc Per failing CI checks, looks like our log10 might not behave as expected for -0. Would you mind taking a look, please?

anandkaranubc · 2025-04-05T19:30:27Z

Haha, was in the middle of writing the reason :)

Oops, there is a bug. log2 and log10 don't return NINF when x = -0.0. But it works in C.

Mainly because of no type casting on hx in JS.

stdlib/lib/node_modules/@stdlib/math/base/special/log2/lib/main.js

Lines 118 to 126 in 7966727

    
           toWords.assign( x, WORDS, 1, 0 ); 
        
           hx = WORDS[ 0 ]; 
        
           lx = WORDS[ 1 ]; 
        
           k = 0|0; // asm type annotation 
        
           if ( hx < HIGH_MIN_NORMAL_EXP ) { 
        
           	// Case: x < 2**-1022 
        
           	if ( ( (hx&ABS_MASK) | lx ) === 0 ) { 
        
           		return NINF; 
        
           	}

hx still remains a "huge" positive number here and isn't less than HIGH_MIN_NORMAL_EXP

But in C,

Typecasting it back again in int32_t makes it negative again.

stdlib/lib/node_modules/@stdlib/math/base/special/log2/src/main.c

Lines 71 to 79 in 7966727

    
           xc = x; 
        
           stdlib_base_float64_to_words( xc, &hx, &lx ); 
        
           ihx = (int32_t)hx; 
        
           k = 0; 
        
           if ( ihx < HIGH_MIN_NORMAL_EXP ) { 
        
           	// Case: x < 2**-1022 
        
           	if ( ( ( ihx & STDLIB_CONSTANT_FLOAT64_HIGH_WORD_ABS_MASK ) | lx ) == 0 ) { 
        
           		return STDLIB_CONSTANT_FLOAT64_NINF; 
        
           	}

cc: @Planeshifter @kgryte

Signed-off-by: Karan Anand <[email protected]>

kgryte · 2025-04-09T07:11:57Z

@anandkaranubc For L22, if the condition assumes ihx, then we can modify to

if ( (hx|0) < HIGH_MIN_NORMAL_EXP ) { 
 	// Case: x < 2**-1022 
 	if ( ( (hx&ABS_MASK) | lx ) === 0 ) { 
 		return NINF; 
 	}

anandkaranubc · 2025-04-09T07:13:41Z

@kgryte Thanks for the reply!

Can I do hx = WORDS[ 0 ] | 0; instead?

PR-URL: stdlib-js#6599 Ref: stdlib-js#365 Reviewed-by: Philipp Burckhardt <[email protected]>

PR-URL: stdlib-js#6590 Reviewed-by: Philipp Burckhardt <[email protected]> Signed-off-by: stdlib-bot <[email protected]>

PR-URL: stdlib-js#6595 Ref: stdlib-js#365 Reviewed-by: Philipp Burckhardt <[email protected]>

PR-URL: stdlib-js#6591 Reviewed-by: Athan Reines <[email protected]>

PR-URL: stdlib-js#6617 Reviewed-by: Athan Reines <[email protected]>

PR-URL: stdlib-js#6612 Reviewed-by: Athan Reines <[email protected]>

PR-URL: stdlib-js#6611 Reviewed-by: Athan Reines <[email protected]>

PR-URL: stdlib-js#6607 Reviewed-by: Athan Reines <[email protected]>

PR-URL: stdlib-js#6608 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: Athan Reines <[email protected]>

PR-URL: stdlib-js#6587 Reviewed-by: Athan Reines <[email protected]>

PR-URL: stdlib-js#6596 Closes: stdlib-js#6588 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: Mahfuza Humayra Mohona <[email protected]> Signed-off-by: Athan Reines <[email protected]>

PR-URL: stdlib-js#6597 Ref: stdlib-js#365 Reviewed-by: Athan Reines <[email protected]> Signed-off-by: Karan Anand <[email protected]>

PR-URL: stdlib-js#5639 Closes: stdlib-js/metr-issue-tracker#20 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: Muhammad Haris <[email protected]> Signed-off-by: Athan Reines <[email protected]>

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

kgryte · 2025-04-09T07:27:26Z

@anandkaranubc Actually, are we sure the issue is with hx here? Given

stdlib/lib/node_modules/@stdlib/math/base/special/log2/lib/main.js

Line 115 in 7966727

if ( isnan( x ) || x < 0.0 ) {

x will be positive once going to toWords. Hence, the sign-bit of the high word will be zero. In which case, hx and hx|0 should be the same value.

anandkaranubc · 2025-04-09T07:29:03Z

/stdlib merge

kgryte · 2025-04-09T07:30:48Z

@anandkaranubc Ah, I see. The special case is -0. In which case, yes, you are right. Based on the code, it should be reasonable to do

hx = WORDS[ 0 ] | 0; // asm type annotation

stdlib-bot · 2025-04-09T07:33:43Z

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/ln	$\color{red}370/382$ $\color{green}+96.86\%$	$\color{red}25/28$ $\color{green}+89.29\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{red}370/382$ $\color{green}+96.86\%$
math/base/special/lnf	$\color{red}372/376$ $\color{green}+98.94\%$	$\color{red}30/32$ $\color{green}+93.75\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{red}372/376$ $\color{green}+98.94\%$
math/base/special/log	$\color{green}171/171$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}171/171$ $\color{green}+100.00\%$
math/base/special/log10	$\color{green}307/307$ $\color{green}+100.00\%$	$\color{green}16/16$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}307/307$ $\color{green}+100.00\%$
math/base/special/log2	$\color{green}290/290$ $\color{green}+100.00\%$	$\color{green}16/16$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}290/290$ $\color{green}+100.00\%$

The above coverage report was generated for the changes in this PR.

anandkaranubc · 2025-04-09T07:37:38Z

lib/node_modules/@stdlib/math/base/special/log10/lib/main.js

@@ -132,7 +132,7 @@ function log10( x ) {

 		// Subnormal number, scale up x:
 		x *= TWO54;
-		hx = getHighWord( x );
+		hx = getHighWord( x ) | 0; // asm type annotation


I also updated this line accordingly to be consistent with upstream (and C) implementation.

Reference

Our C implementation:

stdlib/lib/node_modules/@stdlib/math/base/special/log10/src/main.c

Lines 104 to 106 in 864fc4f

xc *= TWO54;

stdlib_base_float64_get_high_word( xc, &hx );

ihx = (int32_t)hx;

anandkaranubc · 2025-04-09T07:42:00Z

The failing test is unrelated to this PR.

kgryte · 2025-04-09T07:44:20Z

@anandkaranubc I'll fix that up on develop now.

kgryte · 2025-04-09T07:46:22Z

/stdlib merge

kgryte

LGTM

stdlib-bot added Math Issue or pull request specific to math functionality. Needs Review A pull request which needs code review. labels Apr 5, 2025

Merge branch 'develop' into ieee/log

929ebfa

Signed-off-by: Karan Anand <[email protected]>

anandkaranubc added the Tests Pull requests specifically adding tests. label Apr 9, 2025

anandkaranubc and others added 14 commits April 9, 2025 00:15

test: add tests for IEEE 754-2019 compliance

c9143a4

PR-URL: stdlib-js#6599 Ref: stdlib-js#365 Reviewed-by: Philipp Burckhardt <[email protected]>

docs: update list of contributors

fdba081

PR-URL: stdlib-js#6590 Reviewed-by: Philipp Burckhardt <[email protected]> Signed-off-by: stdlib-bot <[email protected]>

test: add tests for IEEE 754-2019 compliance

8e6d16f

PR-URL: stdlib-js#6595 Ref: stdlib-js#365 Reviewed-by: Philipp Burckhardt <[email protected]>

docs: update REPL namespace documentation

262c80b

PR-URL: stdlib-js#6591 Reviewed-by: Athan Reines <[email protected]>

docs: update related packages sections

f33351a

PR-URL: stdlib-js#6617 Reviewed-by: Athan Reines <[email protected]>

docs: replace manual for loop in examples

d31fbf2

PR-URL: stdlib-js#6612 Reviewed-by: Athan Reines <[email protected]>

docs: replace manual for loop in examples

484bcb1

PR-URL: stdlib-js#6611 Reviewed-by: Athan Reines <[email protected]>

docs: replace manual for loop in examples

79ba3b4

PR-URL: stdlib-js#6607 Reviewed-by: Athan Reines <[email protected]>

docs: replace manual for loop in examples

97d8fd3

PR-URL: stdlib-js#6608 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: Athan Reines <[email protected]>

docs: replace manual for loop in examples

58b9836

PR-URL: stdlib-js#6587 Reviewed-by: Athan Reines <[email protected]>

chore: fix EditorConfig lint errors

6df5376

PR-URL: stdlib-js#6596 Closes: stdlib-js#6588 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: Mahfuza Humayra Mohona <[email protected]> Signed-off-by: Athan Reines <[email protected]>

test: add tests for IEEE 754-2019 compliance

7a51d81

PR-URL: stdlib-js#6597 Ref: stdlib-js#365 Reviewed-by: Athan Reines <[email protected]> Signed-off-by: Karan Anand <[email protected]>

feat: add array/base/reshape

e9cd399

PR-URL: stdlib-js#5639 Closes: stdlib-js/metr-issue-tracker#20 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: Muhammad Haris <[email protected]> Signed-off-by: Athan Reines <[email protected]>

stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Apr 9, 2025

Merge remote-tracking branch 'upstream/develop' into ieee/log

ed4a1c1

stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Apr 9, 2025

anandkaranubc commented Apr 9, 2025

View reviewed changes

anandkaranubc requested a review from kgryte April 9, 2025 07:42

stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Apr 9, 2025

Merge remote-tracking branch 'upstream/develop' into ieee/log

994f813

stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Apr 9, 2025

kgryte removed the Needs Review A pull request which needs code review. label Apr 9, 2025

kgryte approved these changes Apr 9, 2025

View reviewed changes

kgryte merged commit c9cacbf into stdlib-js:develop Apr 9, 2025
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: add tests for IEEE 754-2019 compliance #6571

test: add tests for IEEE 754-2019 compliance #6571

anandkaranubc commented Apr 5, 2025

anandkaranubc commented Apr 5, 2025

Planeshifter commented Apr 5, 2025 •

edited

Loading

anandkaranubc commented Apr 5, 2025 •

edited

Loading

kgryte commented Apr 9, 2025

anandkaranubc commented Apr 9, 2025

kgryte commented Apr 9, 2025

anandkaranubc commented Apr 9, 2025

kgryte commented Apr 9, 2025

stdlib-bot commented Apr 9, 2025 •

edited

Loading

anandkaranubc Apr 9, 2025 •

edited

Loading

anandkaranubc Apr 9, 2025

anandkaranubc commented Apr 9, 2025

kgryte commented Apr 9, 2025

kgryte commented Apr 9, 2025

kgryte left a comment

	xc *= TWO54;
	stdlib_base_float64_get_high_word( xc, &hx );
	ihx = (int32_t)hx;

test: add tests for IEEE 754-2019 compliance #6571

test: add tests for IEEE 754-2019 compliance #6571

Conversation

anandkaranubc commented Apr 5, 2025

Description

Related Issues

Questions

Other

Checklist

anandkaranubc commented Apr 5, 2025

Planeshifter commented Apr 5, 2025 • edited Loading

anandkaranubc commented Apr 5, 2025 • edited Loading

kgryte commented Apr 9, 2025

anandkaranubc commented Apr 9, 2025

kgryte commented Apr 9, 2025

anandkaranubc commented Apr 9, 2025

kgryte commented Apr 9, 2025

stdlib-bot commented Apr 9, 2025 • edited Loading

Coverage Report

anandkaranubc Apr 9, 2025 • edited Loading

Choose a reason for hiding this comment

anandkaranubc Apr 9, 2025

Choose a reason for hiding this comment

anandkaranubc commented Apr 9, 2025

kgryte commented Apr 9, 2025

kgryte commented Apr 9, 2025

kgryte left a comment

Choose a reason for hiding this comment

Planeshifter commented Apr 5, 2025 •

edited

Loading

anandkaranubc commented Apr 5, 2025 •

edited

Loading

stdlib-bot commented Apr 9, 2025 •

edited

Loading

anandkaranubc Apr 9, 2025 •

edited

Loading